Wavy Slider/ir.mahozad.multiplatform.wavyslider.material3/WavySlider

WavySlider

@Composable
fun WavySlider(value: Float, onValueChange: (Float) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, onValueChangeFinished: () -> Unit? = null, colors: SliderColors = SliderDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, waveLength: Dp = SliderDefaults.WaveLength, waveHeight: Dp = SliderDefaults.WaveHeight, wavePeriod: Duration = SliderDefaults.WavePeriod, waveMovement: WaveMovement = SliderDefaults.WaveMovement, waveThickness: Dp = SliderDefaults.WaveThickness, trackThickness: Dp = SliderDefaults.TrackThickness, incremental: Boolean = SliderDefaults.Incremental, animationSpecs: WaveAnimationSpecs = SliderDefaults.WaveAnimationSpecs)

See the other overloaded Composable for documentations.

@Composable
fun WavySlider(value: Float, onValueChange: (Float) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, onValueChangeFinished: () -> Unit? = null, colors: SliderColors = SliderDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, waveLength: Dp = SliderDefaults.WaveLength, waveHeight: Dp = SliderDefaults.WaveHeight, wavePeriod: Duration = SliderDefaults.WavePeriod, waveMovement: WaveMovement = SliderDefaults.WaveMovement, waveThickness: Dp = SliderDefaults.WaveThickness, trackThickness: Dp = SliderDefaults.TrackThickness, incremental: Boolean = SliderDefaults.Incremental, animationSpecs: WaveAnimationSpecs = SliderDefaults.WaveAnimationSpecs, thumb: @Composable (SliderPositions) -> Unit = { SliderDefaults.Thumb( interactionSource = interactionSource, colors = colors, enabled = enabled ) }, track: @Composable (SliderPositions) -> Unit = { sliderPositions -> SliderDefaults.Track( colors = colors, enabled = enabled, sliderPositions = sliderPositions, ///////////////// ///////////////// ///////////////// waveLength = waveLength, waveHeight = waveHeight, wavePeriod = wavePeriod, waveMovement = waveMovement, waveThickness = waveThickness, trackThickness = trackThickness, incremental = incremental, animationSpecs= animationSpecs ) })

A wavy slider much like the Material Design 3 slider.

Setting waveHeight or waveLength to 0.dp results in a regular Material Slider.

This component can also be used as a progress bar.

Note that range sliders do not make sense for the wavy slider. So, there is no RangeWavySlider counterpart.

Parameters

value

current value of the WavySlider. it will be coerced to the range 0f..1f.

onValueChange

onValueChange callback in which value should be updated

modifier

the Modifier to be applied to this WavySlider

enabled

controls the enabled state of this WavySlider. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.

onValueChangeFinished

called when value change has ended. This should not be used to update the slider value (use onValueChange instead), but rather to know when the user has completed selecting a new value by ending a drag or a click.

colors

SliderColors that will be used to resolve the colors used for this WavySlider in different states. See SliderDefaults.colors.

interactionSource

the MutableInteractionSource representing the stream of Interactions for this WavySlider. You can create and pass in your own remembered instance to observe Interactions and customize the appearance / behavior of this WavySlider in different states.

waveLength

the distance over which the wave's shape repeats.

waveHeight

the total height of the wave (from crest to trough i.e. amplitude * 2). The final rendered height of the wave will be waveHeight + waveThickness.

wavePeriod

the duration it takes for the wave to move by waveLength horizontally. Setting to Duration.ZERO or outside Int.MIN_VALUE..Int.MAX_VALUE milliseconds stops the movement.

waveMovement

the horizontal movement of the whole wave.

waveThickness

the thickness of the active line (whether animated or not).

trackThickness

the thickness of the inactive line.

incremental

whether to gradually increase height from zero at start to waveHeight at thumb.

animationSpecs

animation configurations used for various properties of the wave.

thumb

the thumb to be displayed on the WavySlider, it is placed on top of the track. The lambda receives a SliderPositions which is used to obtain the current active track.

track

the track to be displayed on the WavySlider, it is placed underneath the thumb. The lambda receives a SliderPositions which is used to obtain the current active track.